docs(all): make docs more coherent #387
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23 tasks
…tools-typescript into docs/general_improv
dreamorosi
requested review from
saragerion,
flochaz,
heitorlessa and
ijemmy
and removed request for
saragerion
saragerion
reviewed
Jan 4, 2022
saragerion
reviewed
Jan 4, 2022
Co-authored-by: Sara Gerion <[email protected]>
Co-authored-by: Sara Gerion <[email protected]>
Co-authored-by: Sara Gerion <[email protected]>
Co-authored-by: Sara Gerion <[email protected]>
Thanks @saragerion, I've found&replaced all other occurrences to |
saragerion
previously approved these changes
Jan 4, 2022
12 tasks
flochaz
suggested changes
Jan 5, 2022
Co-authored-by: Florian Chazal <[email protected]>
Co-authored-by: Florian Chazal <[email protected]>
Co-authored-by: Florian Chazal <[email protected]>
Co-authored-by: Florian Chazal <[email protected]>
flochaz
previously approved these changes
Jan 5, 2022
ijemmy
previously approved these changes
Jan 5, 2022
There was a problem hiding this comment.
Approve. I have some nit and minor comments. But I prefer to have this merged than getting things 100% perfect.
@dreamorosi Appreciate your effort on this. I can see that you really read through and caught all minor details.
| @@ -74,7 +74,7 @@ For a **complete list** of supported environment variables, refer to [this secti | |||
| Environment: | |||
| Variables: | |||
| LOG_LEVEL: WARN | |||
| POWERTOOLS_SERVICE_NAME: shopping-cart-api | |||
| POWERTOOLS_SERVICE_NAME: serverlessAirline | |||
There was a problem hiding this comment.
(minor) There are a few more "shopping-cart-api" left in the doc.
There was a problem hiding this comment.
True, I've missed those. I've now removed all of the ones in the serviceName but left the ones in the function name
| @logger.injectLambdaContext() | ||
| public handler() { | ||
| public async handler(_event: any, _context: any): Promise<void> { |
Co-authored-by: ijemmy <[email protected]>
Co-authored-by: ijemmy <[email protected]>
…owertools-typescript into docs/general_improv
saragerion
approved these changes
Jan 5, 2022
ijemmy
approved these changes
Jan 5, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
This PR includes miscellaneous changes derived from early feedbacks & internal discussion.
Some changes include (but not limited to):
Tracernew Tracer())LambdaInterface& async signature in examplesHow to verify this change
Run docs locally
npm run docs-runLocalDocker& head to http://localhost:8000Related issues, RFCs
#372
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
N/A
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.